error_message

Generate nice error messages.

Classes

NoCacheError

Bases: FileNotFoundError

Custom Assertion when no cached data is available for read.

Source code in pytest_cache_assert/_check_assert/error_message.py

class NoCacheError(FileNotFoundError):
    """Custom Assertion when no cached data is available for read."""

    @beartype
    def __init__(self, path_cache_file: Path) -> None:
        super().__init__(f'No cache for: {path_cache_file}')

RichAssertionError

Bases: AssertionError

Custom AssertionError with additional error_info.

Source code in pytest_cache_assert/_check_assert/error_message.py

class RichAssertionError(AssertionError):
    """Custom AssertionError with additional `error_info`."""

    def __init__(self, *args: Any, error_info: Any = None) -> None:
        """Store the error_info for later access."""  # noqa: DAR101
        super().__init__(*args)
        self.error_info = error_info

    @classmethod
    @beartype
    def create_message(
        cls,
        test_data: Any,   # noqa: ARG003
        cached_data: Any,  # noqa: ARG003
        path_cache_file: Path,
        diff_results: DiffResults,
    ) -> str:
        """Create the error message.

        Args:
            test_data: the test data
            cached_data: the cached data
            path_cache_file: the path to the cache file
            diff_results: the diff results

        Returns:
            str: pleasant error message

        """
        @beartype
        def fmt_line(prefix: str, data: Any) -> str:
            indented_data = ('\n' + ' ' * len(prefix)).join(pformat(data).split('\n'))
            return f'{prefix}{indented_data}'

        diff_prefix = '> Differences: '
        line_diff = fmt_line(diff_prefix, diff_results.to_dict())
        file_diff = f'\n> Found differences with: {path_cache_file}' if path_cache_file else ''
        return f'{file_diff}\n{line_diff}\n'

Functions

__init__

__init__(*args, error_info=None)

Store the error_info for later access.

Source code in pytest_cache_assert/_check_assert/error_message.py

def __init__(self, *args: Any, error_info: Any = None) -> None:
    """Store the error_info for later access."""  # noqa: DAR101
    super().__init__(*args)
    self.error_info = error_info

create_message classmethod

create_message(test_data, cached_data, path_cache_file, diff_results)

Create the error message.

PARAMETER	DESCRIPTION
test_data	the test data TYPE: Any
cached_data	the cached data TYPE: Any
path_cache_file	the path to the cache file TYPE: Path
diff_results	the diff results TYPE: DiffResults

RETURNS	DESCRIPTION
str	pleasant error message TYPE: str

Source code in pytest_cache_assert/_check_assert/error_message.py

@classmethod
@beartype
def create_message(
    cls,
    test_data: Any,   # noqa: ARG003
    cached_data: Any,  # noqa: ARG003
    path_cache_file: Path,
    diff_results: DiffResults,
) -> str:
    """Create the error message.

    Args:
        test_data: the test data
        cached_data: the cached data
        path_cache_file: the path to the cache file
        diff_results: the diff results

    Returns:
        str: pleasant error message

    """
    @beartype
    def fmt_line(prefix: str, data: Any) -> str:
        indented_data = ('\n' + ' ' * len(prefix)).join(pformat(data).split('\n'))
        return f'{prefix}{indented_data}'

    diff_prefix = '> Differences: '
    line_diff = fmt_line(diff_prefix, diff_results.to_dict())
    file_diff = f'\n> Found differences with: {path_cache_file}' if path_cache_file else ''
    return f'{file_diff}\n{line_diff}\n'

---

Last update: August 30, 2023
Created: August 30, 2023